IApi.GetStatus method

Gets the state of an EtherCAT link. Use this method to see when the link has been established. After the link is established you can access the number of I/O and servo modules.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsError GetStatus(
       SubsystemStatus Status,
       SubsystemDiagnostics Diagnostics
)

Function GetStatus(
       Status As SubsystemStatus,
       Diagnostics As SubsystemDiagnostics
) As KsError

Parameters

Status

Type: SubsystemStatus

Shows the state of the EtherCAT link.

Diagnostics

Type: SubsystemDiagnostics

Shows the diagnostics information of EtherCAT slaves' state.

Return value

Type: KsError

A return code of a method.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A